IUpdateHandler Class Reference

Host implements dependency handling for plugins. More...

#include <iupdatehandler.h>

Inheritance diagram for IUpdateHandler:
Inheritance graph
[legend]

Public Member Functions

virtual tresult addDependent (FUnknown *object, IDependent *dependent)=0
 Install update notification for given object.
virtual tresult removeDependent (FUnknown *object, IDependent *dependent)=0
 Remove a previously installed dependency.
virtual tresult triggerUpdates (FUnknown *object, int32 message)=0
 Inform all dependents, that object has changed.
virtual tresult deferUpdates (FUnknown *object, int32 message)=0
 Same as triggerUpdates, but delivered in idle (usefull to collect updates).

Static Public Attributes

static const FUID iid

Detailed Description

Host implements dependency handling for plugins.

[host imp]
[get this interface from IHostClasses]
[released N3.1]

Can be used between host-objects and the Plug-In or inside the Plug-In to handle internal updates!

See also:
IDependent

Member Function Documentation

virtual tresult addDependent ( FUnknown object,
IDependent dependent 
) [pure virtual]

Install update notification for given object.

It is essential to remove all dependencies again using 'removeDependent'! Dependencies are not removed automatically when the 'object' is released!

Parameters:
object : interface to object that sends change notifications
dependent : interface through which the update is passed
virtual tresult removeDependent ( FUnknown object,
IDependent dependent 
) [pure virtual]

Remove a previously installed dependency.

virtual tresult triggerUpdates ( FUnknown object,
int32  message 
) [pure virtual]

Inform all dependents, that object has changed.

Parameters:
object is the object that has changed
message is a value of enum IDependent::ChangeMessage, usually IDependent::kChanged - can be a private message as well (only known to sender and dependent)
virtual tresult deferUpdates ( FUnknown object,
int32  message 
) [pure virtual]

Same as triggerUpdates, but delivered in idle (usefull to collect updates).


Field Documentation

const FUID iid [static]

Reimplemented from FUnknown.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.